LearningDataModel.SuspendData Property

Gets or sets data used to persist the current RLO state during a suspension.

Parent Type: LearningDataModel

Namespace: Microsoft.LearningComponents.DataModel

Assembly: Microsoft.LearningComponents.dll

Syntax
C#

public string SuspendData

{ get; set; }
Exceptions
Exception type Condition
InvalidOperationException

Thrown if this LearningDataModel object cannot be written to.

ArgumentOutOfRangeException

Thrown if the string passed is longer than BaseSchemaInternal.ActivityAttemptItem.MaxSuspendDataLength characters in SCORM 2004 packages, or longer than 4096 characters in SCORM 1.2 packages.

Remarks

In SCORM 2004, this corresponds to cmi.suspend_data.

In SCORM 1.2, this corresponds to cmi.core.suspend_data.

A string designed to be opaque to the application, for use only by the RLO. This may be used to store any data necessary to restart the RLO after a suspend operation.

If the value has not been set before being accessed, null is returned.